Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

TiPullXmlAttribute Class Reference

#include <tinyxml.h>

Inheritance diagram for TiPullXmlAttribute:

Inheritance graph
[legend]
Collaboration diagram for TiPullXmlAttribute:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TiPullXmlAttribute ()
 Construct an empty attribute.

 TiPullXmlAttribute (const char *_name, const char *_value)
 Construct an attribute with a name and value.

const char * Name () const
 Return the name of this attribute.

const char * Value () const
 Return the value of this attribute.

const int IntValue () const
 Return the value of this attribute, converted to an integer.

const double DoubleValue () const
 Return the value of this attribute, converted to a double.

int QueryIntValue (int *value) const
int QueryDoubleValue (double *value) const
 QueryDoubleValue examines the value string. See QueryIntValue().

void SetName (const char *_name)
 Set the name of this attribute.

void SetValue (const char *_value)
 Set the value.

void SetIntValue (int value)
 Set the value from an integer.

void SetDoubleValue (double value)
 Set the value from a double.

TiPullXmlAttribute * Next () const
 Get the next sibling attribute in the DOM. Returns null at end.

TiPullXmlAttribute * Previous () const
 Get the previous sibling attribute in the DOM. Returns null at beginning.

bool operator== (const TiPullXmlAttribute &rhs) const
bool operator< (const TiPullXmlAttribute &rhs) const
bool operator> (const TiPullXmlAttribute &rhs) const
virtual bool Parse (ParsePosition in, const char *&out, bool throwaway)
virtual void Print (FILE *cfile, int depth) const
virtual void StreamOut (TiXmlOutStream *out) const
void SetDocument (TiPullXmlDocument *doc)

Private Attributes

TiPullXmlDocumentdocument
TiXmlString name
TiXmlString value
TiPullXmlAttribute * prev
TiPullXmlAttribute * next

Friends

class TiPullXmlAttributeSet

Detailed Description

An attribute is a name-value pair. Elements have an arbitrary number of attributes, each with a unique name.

Note:
The attributes are not TiXmlNodes, since they are not part of the tinyXML document object model. There are other suggested ways to look at this problem.


Constructor & Destructor Documentation

TiPullXmlAttribute::TiPullXmlAttribute   [inline]
 

Construct an empty attribute.

TiPullXmlAttribute::TiPullXmlAttribute const char *    _name,
const char *    _value
[inline]
 

Construct an attribute with a name and value.


Member Function Documentation

const double TiPullXmlAttribute::DoubleValue   const
 

Return the value of this attribute, converted to a double.

const int TiPullXmlAttribute::IntValue   const
 

Return the value of this attribute, converted to an integer.

const char* TiPullXmlAttribute::Name   const [inline]
 

Return the name of this attribute.

TiPullXmlAttribute * TiPullXmlAttribute::Next   const
 

Get the next sibling attribute in the DOM. Returns null at end.

bool TiPullXmlAttribute::operator< const TiPullXmlAttribute &    rhs const [inline]
 

bool TiPullXmlAttribute::operator== const TiPullXmlAttribute &    rhs const [inline]
 

bool TiPullXmlAttribute::operator> const TiPullXmlAttribute &    rhs const [inline]
 

bool TiPullXmlAttribute::Parse ParsePosition    in,
const char *&    out,
bool    throwaway
[virtual]
 

Implements TiPullXmlBase.

TiPullXmlAttribute * TiPullXmlAttribute::Previous   const
 

Get the previous sibling attribute in the DOM. Returns null at beginning.

void TiPullXmlAttribute::Print FILE   cfile,
int    depth
const [virtual]
 

All TinyXml classes can print themselves to a filestream. This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

Implements TiPullXmlBase.

int TiPullXmlAttribute::QueryDoubleValue double *    value const
 

QueryDoubleValue examines the value string. See QueryIntValue().

int TiPullXmlAttribute::QueryIntValue int *    value const
 

QueryIntValue examines the value string. It is an alternative to the IntValue() method with richer error checking. If the value is an integer, it is stored in 'value' and the call returns TIXML_SUCCESS. If it is not an integer, it returns TIXML_WRONG_TYPE.

A specialized but useful call. Note that for success it returns 0, which is the opposite of almost all other TinyXml calls.

void TiPullXmlAttribute::SetDocument TiPullXmlDocument   doc [inline]
 

void TiPullXmlAttribute::SetDoubleValue double    value
 

Set the value from a double.

void TiPullXmlAttribute::SetIntValue int    value
 

Set the value from an integer.

void TiPullXmlAttribute::SetName const char *    _name [inline]
 

Set the name of this attribute.

void TiPullXmlAttribute::SetValue const char *    _value [inline]
 

Set the value.

void TiPullXmlAttribute::StreamOut TiXmlOutStream *    out const [virtual]
 

Implements TiPullXmlBase.

const char* TiPullXmlAttribute::Value   const [inline]
 

Return the value of this attribute.


Friends And Related Function Documentation

friend class TiPullXmlAttributeSet [friend]
 


Member Data Documentation

TiPullXmlDocument* TiPullXmlAttribute::document [private]
 

TiXmlString TiPullXmlAttribute::name [private]
 

TiPullXmlAttribute* TiPullXmlAttribute::next [private]
 

TiPullXmlAttribute* TiPullXmlAttribute::prev [private]
 

TiXmlString TiPullXmlAttribute::value [private]
 


The documentation for this class was generated from the following files:
Generated on Mon Sep 12 20:18:02 2005 for Destiny3D by doxygen1.3-rc3